Skip to content

docs: audit games module page#21

Merged
demengc merged 1 commit intomainfrom
docs/audit-games-module
Mar 24, 2026
Merged

docs: audit games module page#21
demengc merged 1 commit intomainfrom
docs/audit-games-module

Conversation

@demengc
Copy link
Copy Markdown
Owner

@demengc demengc commented Mar 24, 2026

Summary

  • Fix compile errors: all .bindWith(this) calls inside GameState subclass examples replaced with bind(...), since GameState does not implement TerminableConsumer
  • Fix incorrect duration=0 semantics: old doc claimed 0 means "infinite duration", but the state actually ends on its first update() call; documented how to override isReadyToEnd() for indefinite states
  • Add API reference tables for GameState lifecycle hooks and public methods with correct signatures, return types, and visibility
  • Add ScheduledStateSeries documentation with constructor table, addNext() methods, and full example
  • Remove filler comments, redundant "Benefits" section, and incorrect State Lifecycle snippet that referenced isReadyToEnd() as a public call pattern
  • Add Maven dependency snippet with correct artifact coordinates

Test plan

  • Verify markdown renders correctly on GitBook
  • Confirm all code examples match the current GameState and ScheduledStateSeries API signatures

Fix compile errors in code examples (bindWith(this) inside GameState
subclasses does not compile since GameState does not implement
TerminableConsumer), correct duration=0 semantics (ends immediately,
not infinite), and restructure the page with API reference tables,
accurate method signatures, and ScheduledStateSeries documentation.
@demengc demengc merged commit 2348362 into main Mar 24, 2026
2 of 3 checks passed
@demengc demengc deleted the docs/audit-games-module branch March 24, 2026 02:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant